FindItemTagObject Method, SftTree Class


	FindItemTagObject Method, SftTree Class	Softel vdm, Inc.

Searches the TagObjects property of items for an object.

Syntax SftTree Class (Softelvdm.SftTreeNET)

VB	Public Function FindItemTagObject( _ ByVal Data As Object, _ ByVal Wrap As Boolean, _ ByVal StartItem As ItemClass, _ ByVal DepthScan As Boolean, _ ByVal VisibleOnly As Boolean _ ) As ItemClass
C#	public ItemClass FindItemTagObject( object Data, bool Wrap, ItemClass StartItem, bool DepthScan, bool VisibleOnly );
C++	public: ItemClass^ FindItemTagObject( Object^ Data, bool Wrap, ItemClass^ StartItem, bool DepthScan, bool VisibleOnly );

Data

Defines the object to find.

DepthScan

Defines whether all items (including dependent items, starting with the starting item StartItem) are searched (True), otherwise False and only sibling items of the starting item (StartItem) are searched.

StartItem

Defines the item where the search starts (including).

VisibleOnly

Defines whether only visible items are searched (True), otherwise False and all items (even items whose parents are collapsed) are searched.

Wrap

Defines whether the search wraps around at the end of the items and resumes at the first item (True), otherwise False.

Return Value

The item where the first match is found or null/Nothing if no match was found.

Comments

The FindItemTagObject method searches the TagObjects property of items for an object.

The FindItemTagObject method searches all items, starting at the item defined by StartItem for the object (Data) in each item's ItemClass.TagObjects property.

The FindItemTagString, FindCellTagObject, FindCellTagString methods perform similar function to search items' and cells' TagObjects and TagString properties. The FindText property searches for a matching string in the CellBaseClass.Text property.